﻿// -----------------------------------------------------------------------
// <copyright company="www.3WayWebdesign.de">
// Permission is hereby granted, free of charge, to any person obtaining
// a copy of this software and associated documentation files (the
// "Software"), to deal in the Software without restriction, including
// without limitation the rights to use, copy, modify, merge, publish,
// distribute, sublicense, and/or sell copies of the Software, and to
// permit persons to whom the Software is furnished to do so, subject to
// the following conditions:
// 
// The above copyright notice and this permission notice shall be
// included in all copies or substantial portions of the Software.
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
// EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
// MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
// NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
// LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
// OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
// WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
// </copyright>
// 
// <author>Michael Morbach</author>
// <email>Michael@3waywebdesign.de</email>
// <web>http://www.3waywebdesign.de</web>
// ----------------------------------------------------------------------

using System;
using System.Collections.ObjectModel;
using System.Collections.Specialized;
using System.ComponentModel;
using Tww.MAF.MAFEngine.Navigator;

namespace Tww.MAF.MAFEngine.Navigation.Browser
{
    public interface IBrowser : INotifyCollectionChanged, INotifyPropertyChanged, INotifyPropertyChanging
    {
        #region  - Indexer und Eigenschaften (öffentlich) -

        /// <summary>
        /// Adds a new navigator.
        /// </summary>
        void AddNewNavigator();

        /// <summary>
        /// Adds a navigator.
        /// </summary>
        /// <param name="navigator">The navigator.</param>
        void AddNavigator(INavigator navigator);

        /// <summary>
        /// Gets the current navigator.
        /// </summary>
        /// <value>
        /// The current navigator.
        /// </value>
        INavigator CurrentNavigator { get; }


        /// <summary>
        /// Gets the navigator factory.
        /// </summary>
        /// <value>
        /// The navigator factory.
        /// </value>
        INavigatorFactory NavigatorFactory { get; }


        /// <summary>
        /// Gets or sets the navigator list.
        /// </summary>
        /// <value>
        /// The navigator list.
        /// </value>
        ReadOnlyObservableCollection<INavigator> NavigatorList { get; }

        #endregion

        #region  - Methoden (öffentlich) -

        /// <summary>
        /// Navigates to the specified destination.
        /// </summary>
        /// <param name="navigatorId">The navigator identifier.</param>
        /// <param name="destination">The destination.</param>
        /// <param name="context">The context.</param>
        /// <param name="navigationCallback">The navigation callback.</param>
        void Navigate(Guid navigatorId, Uri destination, NavigationContext context, Action<NavigationResult> navigationCallback);


        /// <summary>
        /// Navigates to the specified destination.
        /// </summary>
        /// <param name="navigator">The navigator.</param>
        /// <param name="destination">The destination.</param>
        /// <param name="context">The context.</param>
        /// <param name="navigationCallback">The navigation callback.</param>
        void Navigate(INavigator navigator, Uri destination, NavigationContext context, Action<NavigationResult> navigationCallback);

        /// <summary>
        /// Navigates to the specified destination inside a new Navigator
        /// </summary>
        /// <param name="destination">The destination.</param>
        /// <param name="context">The context.</param>
        /// <param name="navigationCallback">The navigation callback.</param>
        void NavigateInNewNavigator(Uri destination, NavigationContext context, Action<NavigationResult> navigationCallback);

        #endregion
    }
}